// --------------------------------------------------------------------------------------------------------------------
// <copyright file="IProtocol.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Hardware.DAC
{
    using System;

    /// <summary>
    /// Delegate to parse the specifics of the message payload
    /// </summary>
    /// <param name="buffer">Message buffer</param>
    /// <param name="packetType">The packet type</param>
    /// <param name="sequenceNumber">The packet sequence number</param>
    /// <param name="offset">Offset into the buffer</param>
    /// <param name="length">Length of the payload</param>
    public delegate void ParseMessage(byte[] buffer, byte packetType, int sequenceNumber, int offset, int length);

    /// <summary>
    /// Interface for protocol implementations in firmware service
    /// </summary>
    public interface IProtocol : IDisposable
    {
        /// <summary>
        /// Runs a command
        /// </summary>
        /// <param name="command">The command to run</param>
        /// <param name="asyncWrite">The write buffer</param>
        void RunCommand(ICommand command, AsyncEventArgs asyncWrite);

        /// <summary>
        /// Extract the message data
        /// </summary>
        /// <param name="eventArgs">The buffer</param>
        /// <param name="parse">The message parser</param>
        /// <returns>Parsed successful or not</returns>
        bool ExtractMessageData(AsyncEventArgs eventArgs, ParseMessage parse);

        /// <summary>
        /// Get the next packet sequence number
        /// </summary>
        /// <returns>The sequence number</returns>
        ushort GetNextSequenceNumber();
    }
}
